<font color='#e22222' size=-1><i>Bleeding edge, baby! This is a work in progress and may not
accurately reflect all aspects of the program</i>.</font>

<h1>Overview</h1>

Robot Framework Workbench (RWB) is an integrated development environment
for working with robot framework test suites. 

The main window consists of several <i>panels</i> which are organized
into different <a href="#Views">views</a> which may be accessed via
the <b>View</b> menu. Two views are currently
supported: <a href="#Browse Mode">Browse Mode</a> and
<a href="#Edit Mode">Edit Mode</a>.

<h1>Views</h1> 

Views are made up of one or more <a href="#Panels">panels</a> and
toolbars, which may be added to or removed from the current view via
the <b>View</b> menu, which has submenus for <b> Panels</b>
and <b>Toolbars</b>.

You may move most panels by clicking and dragging over the titlebar
above each panel. When you exit, the workbench will remember
the current layout and restore it the next time it starts up.
 
<h2>Browse Mode</h2>
Browse mode is designed to make it easy to browse an existing test suite.
By default it is made up of a <a href="#Test Suite Navigator">test
suite navigator</a> panel and a <a href="#Test Suite Browser">test suite
browser</a> panel.

<h2>Edit Mode</h2>
Edit mode can be used to edit robot framework test suites (<b>warning: editing
is not fully supported yet</b>).

By default, edit mode is made up of the <a href="#Test Suite Navigator">test 
suite navigator</a> panel and the <a href="#Editor">editor</a> panel. Double-
clicking over a test case or test suite in the navigator will open up
a new tab in the editor notebook. 

<h1>Panels</h1>

Panels are individual windows which may be added to or removed
from a <a href="#Views">view</a>. Many panels are built-in, but you
can add additional panels via plugins.

All of the available panels can be added to or removed from the
current view via the <b>View</b> menu, under the <b>Panel</b> submenu. 

<!-- 
     all of the information under this heading should be
     denterated dynamically ...
-->

<h2>Test Suite Navigator</h2>
The Test Suite Navigator panel shows a tree view of a robot framework
test suite. Single-clicking over a test suite or test case in the 
navigator will cause the <a href="#Test SUite Browser">browse panel</a> 
to display the item that was clicked on. The navigator and browse panel are 
the main two windows used in <a href="#Browse Mode">. With these two panels it 
is easy to quickly browse the contents of a test suite.

When you double-click on a test suite or test case in the navigator, the
<a href="#Editor">Editor panel</a> will be displayed, and a new
tab will be created for the item that was clicked on. 

You can right-click over the navigator to get a menu of other functions 
that can be performed, including an option for running the Robot 
Static Analyzer (RSA).

<h2>Test Suite Browser</h2>
The Robot Framework Browser panel is for quickly viewing a test suite or
test case. It cannot be used to edit test suites and test cases. It 
will display whatever item was most recently clicked in the 
<a href="#Test Suite Navigator">navigator</a> panel.

<h2>Editor</h2>

The Editor is a tabbed window which is used for editing files and
robot framework test suites and test cases. Each object to be edited
will be opened in a new notebook tab.

Whenever you click on a test suite or test case in the <a href="#Test Suite Navigator">,
a new tab will be created in the edtior for that object.

You may also open arbitrary files in the editor by using the <b>File</b> menu.

<h2>Service Panel</h2>

The service panel is a notebook widget that appears at the bottom of the main window.
The service panel is used to display the output of some external process. For
example, when you run RSA, an RSA tab will be added to the service panel for the
purpose of showing violations.

<h2>Robot Static Analyzer (RSA)</h2> The Robot Static Analyzer (RSA)
window appears on the <a href="#Service Panel">service panel</a>, and may be accessed
when running RSA via the <a href="#Test Suite Navigator">navigator</a> context sensitive menu.  
Selecting <b>RSA</b> from this menu will show the service panel with the RSA tab selected. 
The RSA tab will contain a list of suspected violations as determined by RSA. 

<h2>The Clipboard</h2>
The Clipboard panel contantly monitors the system clipboard, saving copies
of whatever appears on the clipboard. When you single click on an item
in this panel, that item is copied back to the system clipboard, making
it easy to copy and paste multiple items.


